STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

H.?? StructureDefinition: hspc-bmi

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/hspc-bmi

The HSPC specific profile for a body mass index observation

This profile was published on Tue, Jun 16, 2015 00:00+1000 as a draft by HSPC.

H.??.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from QICore-Observation.

Summary

Mandatory: 1 element
Fixed Value: 3 elements
Prohibited: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

This structure is derived from QICore-Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationMeasurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... hspc-extensionsdeltaFlag 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsdeltaFlag
Binding: Abnormal Interpretation Numeric Nom (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierUnique Id for this particular observation
... status ?! S∑1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatusBasic (required)
... category 0..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code S ∑1..1CodeableConceptType of observation (code / type)
Binding: US Laboratory Observation Profile Observation Name Codes (preferred)
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"39156-5","display":"Body mass index (BMI) [Ratio]"}]}
... subject S ∑0..1Reference(QICore-Patient | Group | QICore-Device | QICore-Location)Who and/or what this is about
... encounter S0..1Reference(QICore-Encounter)Healthcare event during which this observation is made
... effective[x] S ∑0..1dateTime, PeriodClinically relevant time/time-period for observation
... performer ∑0..*Reference(HSPC ProviderPractitioner | HSPCOrganization | HSPC-Patient | RelatedPerson)Who is responsible for the observation
... value[x] S ∑1..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual result
Binding: SNOMED CT Codes (preferred)
... interpretation S0..1CodeableConceptHigh, low, normal, etc.
Binding: Abnormal Interpretation Numeric Nom (preferred)
... comment 0..1stringComments about result
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... meaning 0..1CodeableConceptIndicates the meaning/use of this range of this range
Binding: Observation Reference Range Meaning Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... related S ∑0..*BackboneElementResource related to this observation
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... type 0..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required)
.... target 1..1Reference(QICore-Observation | QuestionnaireResponse)Resource that is related to this one
... component ∑0..*BackboneElementComponent results
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... code ∑ I1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... referenceRange 0..*Unknown reference to #referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

todo

This structure is derived from QICore-Observation.

Summary

Mandatory: 1 element
Fixed Value: 3 elements
Prohibited: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from QICore-Observation.

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationMeasurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... hspc-extensionsdeltaFlag 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsdeltaFlag
Binding: Abnormal Interpretation Numeric Nom (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierUnique Id for this particular observation
... status ?! S∑1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatusBasic (required)
... category 0..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code S ∑1..1CodeableConceptType of observation (code / type)
Binding: US Laboratory Observation Profile Observation Name Codes (preferred)
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"39156-5","display":"Body mass index (BMI) [Ratio]"}]}
... subject S ∑0..1Reference(QICore-Patient | Group | QICore-Device | QICore-Location)Who and/or what this is about
... encounter S0..1Reference(QICore-Encounter)Healthcare event during which this observation is made
... effective[x] S ∑0..1dateTime, PeriodClinically relevant time/time-period for observation
... performer ∑0..*Reference(HSPC ProviderPractitioner | HSPCOrganization | HSPC-Patient | RelatedPerson)Who is responsible for the observation
... value[x] S ∑1..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual result
Binding: SNOMED CT Codes (preferred)
... interpretation S0..1CodeableConceptHigh, low, normal, etc.
Binding: Abnormal Interpretation Numeric Nom (preferred)
... comment 0..1stringComments about result
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... meaning 0..1CodeableConceptIndicates the meaning/use of this range of this range
Binding: Observation Reference Range Meaning Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... related S ∑0..*BackboneElementResource related to this observation
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... type 0..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required)
.... target 1..1Reference(QICore-Observation | QuestionnaireResponse)Resource that is related to this one
... component ∑0..*BackboneElementComponent results
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... code ∑ I1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... referenceRange 0..*Unknown reference to #referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

H.??.2 Terminology Bindings

PathNameConformanceValueSet
Observation.language?extrequiredhttp://tools.ietf.org/html/bcp47
Observation.extension
[UriType[http://hl7.org/fhir/StructureDefinition/hspc-extensionsdeltaFlag]]		Abnormal Interpretation Numeric NompreferredAbnormal Interpretation Numeric Nom
Observation.statusObservationStatusBasicrequiredObservationStatusBasic
Observation.categoryObservation Category CodesexampleObservation Category Codes
Observation.codeUS Laboratory Observation Profile Observation Name CodespreferredUS Laboratory Observation Profile Observation Name Codes
Observation.value[x]SNOMED CT CodespreferredSNOMED CT Codes
Observation.interpretationAbnormal Interpretation Numeric NompreferredAbnormal Interpretation Numeric Nom
Observation.referenceRange.meaningObservation Reference Range Meaning CodesexampleObservation Reference Range Meaning Codes
Observation.related.typeObservationRelationshipTyperequiredObservationRelationshipType
Observation.component.codeLOINC CodesexampleLOINC Codes
Observation.component.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason

H.??.3 Constraints

IdPathDetailsRequirements
obs-6ObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
XPath: not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))
obs-7ObservationComponent code SHALL not be same as observation code
XPath: not(exists(f:component/f:code)) or count(for $coding in f:code/f:coding return parent::*/f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value and f:system/@value=$coding/f:system/@value])=0
obs-3Observation.referenceRangeMust have at least a low or a high or text
XPath: (exists(f:low) or exists(f:high)or exists(f:text))
.